Repository navigation
Consolidate environment configuration and update test documentation - #305
Merged
Merged
Conversation
Replace legacy environment samples with a sanitized root .env.example, update CI and documentation, and record the test database setup for coding agents. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Use the development database role and password in the environment template. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Document the Django test runner for regular and coverage runs, removing obsolete Nose and unittest discovery instructions. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 Changes recommended
Environment sourcing can break CI and documented setup, while the default database host may break Docker deployments.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR consolidates environment configuration, updates setup documentation, and removes obsolete environment files.
Changes:
- Adds a sanitized
.env.examplefor local development and CI. - Updates README, AGENTS, CONTRIBUTING, and CI configuration.
- Removes obsolete
contribsamples andpath.envreferences.
Review findings:
- Critical (3 votes): Unquoted values can cause CI environment sourcing to fail.
- Moderate (3 votes): The same values break the documented README setup.
- Moderate (2 votes): The default database host may fail in Docker deployments.
File summaries
| File | Summary |
|---|---|
README.md |
Updates environment setup and test instructions. |
CONTRIBUTING.md |
Removes obsolete contrib/ documentation. |
contrib/path.env-sample |
Removes obsolete path template. |
contrib/env-sample |
Removes obsolete environment template. |
AGENTS.md |
Adds environment, database, testing, and CI guidance. |
.gitignore |
Removes the obsolete path.env rule. |
.github/workflows/pythonapp.yml |
Uses the new environment template in CI. |
.env.example |
Provides a consolidated sanitized environment template. |
Review details
Suppressed comments (1)
.env.example:28
- This host value is also consumed by
docker-compose.yml, which injects.envinto thewebcontainer while linking PostgreSQL aspostgres-server. A deployment that copies this template without overriding the value will make the web container connect to its own localhost and fail; set the Docker service's database host explicitly or document a Docker-specific override.
- Files reviewed: 7/8 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Quote values containing spaces so the CI setup can source the generated environment file. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Use sourceable origin lists and configure the session duration from the environment. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove the unused commented Matplotlib plotting implementation and its imports from the views module. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request focuses on simplifying and improving environment configuration for local development and CI, as well as updating documentation to match these changes. The main updates include introducing a single
.env.examplefile with placeholder values, removing obsolete files and references, and clarifying setup steps for both developers and CI workflows.Environment configuration improvements:
.env.examplewith placeholder values for sensitive data, replacing previous.envandcontrib/env-samplefiles, and updated to remove real credentials and unused variables such asDATABASE_TEST(.env.example, [1] [2] [3]..env.exampleto.envand set database credentials for tests, ensuring compatibility with the new configuration approach (.github/workflows/pythonapp.yml, .github/workflows/pythonapp.ymlL59-R61).Documentation updates:
AGENTS.mdas a comprehensive guide for setting up local environments, configuring the database and test permissions, running tests, and understanding CI environment expectations.README.mdto reference.env.example, remove references topath.envandcontrib/, and clarify environment setup and test execution steps [1] [2] [3].contrib/fromCONTRIBUTING.mdandcontrib/path.env-sample[1] [2].These changes make environment setup more secure, consistent, and easier to follow for both new contributors and CI processes.